| Setting | Description |
| $main::SETTINGS->{dir}->{data} |
The full path to the data directory (where
all internal, channel, and list data lives). Determined by
taking $main::SETTINGS->{dir}->{location} and
appending 'data'. Default: /path/to/AmphetaDesk/data/. |
| $main::SETTINGS->{dir}->{data_channels} |
The full path to the directory where
all the channel files are saved. Determined by taking
$main::SETTINGS->{dir}->{data} and
appending 'channels'. Default: /path/to/AmphetaDesk/data/channels/. |
| $main::SETTINGS->{dir}->{data_internal} |
The full path to the directory where
all the boring internal files are stored, like the logfiles,
version checks, and so forth. Determined by taking
$main::SETTINGS->{dir}->{dir_data} and
appending 'internal'. Default: /path/to/AmphetaDesk/data/internal/. |
| $main::SETTINGS->{dir}->{data_lists} |
The full path to the directory where
all the service lists (containing the possible channels to
subscribe to) are saved. Determined by taking $main::SETTINGS->{dir}->{data}
and then appending 'lists'. Default:
/path/to/AmphetaDesk/data/lists/. |
| $main::SETTINGS->{dir}->{dlmtr} |
This is the directory delimiter, used
to create various full paths to our our directories. Defaults to
/ but will become a : if on a Macintosh. |
| $main::SETTINGS->{dir}->{docs} |
The full path to the docs directory (where
all documentation is located). This variable is set so
that the webserver knows where to remap requests to.
Determined by taking $main::SETTINGS->{dir}->{location}
and appending 'docs'. Default: /path/to/AmphetaDesk/docs/. |
| $main::SETTINGS->{dir}->{gui} |
The full path to the gui directory (where
all icons and logos are stored for the runtime GUI). Determined by
taking $main::SETTINGS->{dir}->{location} and
appending 'gui'. Default: /path/to/AmphetaDesk/gui/. |
| $main::SETTINGS->{dir}->{location} |
Determined at runtime, this is the
full path to the running directory of the program - most of
the other path information is determined from this
variable. |
| $main::SETTINGS->{dir}->{templates} |
The full path to the template directory.
Determined by taking $main::SETTINGS->{dir}->{location}
and appending 'templates'. Default: /path/to/AmphetaDesk/templates/. |
| $main::SETTINGS->{files}->{gui_linux_icon} |
Full path to the Linux icon. Determined by taking
$main::SETTINGS->{dir}->{gui} and adding
<gui_linux_icon>. Default:
/path/to/AmphetaDesk/gui/linux_icon.png. |
| $main::SETTINGS->{files}->{gui_linux_logo} |
Full path to the Linux logo. Determined by taking
$main::SETTINGS->{dir}->{gui} and adding
<gui_linux_logo>. Default:
/path/to/AmphetaDesk/gui/linux_logo.png. |
| $main::SETTINGS->{files}->{gui_macos_icon} |
Full path to the MacOS icon. Determined by taking
$main::SETTINGS->{dir}->{gui} and adding
<gui_macos_icon>. Default:
/path/to/AmphetaDesk/gui/macos_icon.pict. |
| $main::SETTINGS->{files}->{gui_macos_logo} |
Full path to the MacOS logo. Determined by taking
$main::SETTINGS->{dir}->{gui} and adding
<gui_macos_logo>. Default:
/path/to/AmphetaDesk/gui/macos_logo.pict. |
| $main::SETTINGS->{files}->{gui_win_icon} |
Full path to the Windows icon. Determined by taking
$main::SETTINGS->{dir}->{gui} and adding
<gui_win_icon>. Default:
/path/to/AmphetaDesk/gui/win_icon.ico. |
| $main::SETTINGS->{files}->{gui_win_logo} |
Full path to the Windows logo. Determined by taking
$main::SETTINGS->{dir}->{gui} and adding
<gui_win_logo>. Default:
/path/to/AmphetaDesk/gui/win_logo.bmp. |
| $main::SETTINGS->{files}->{log} |
Full path to the program's logfile. Determined by taking
$main::SETTINGS->{dir}->{internal} and adding
<file_log>. Default:
/path/to/AmphetaDesk/data/internal/AmphetaDesk.log. |
| $main::SETTINGS->{files}->{myChannels} |
Full path to the user's subscription list.
Determined by taking $main::SETTINGS->{dir}->{data} and adding
<file_myChannels>. Default:
/path/to/AmphetaDesk/data/myChannels.opml. |
| $main::SETTINGS->{files}->{mySettings} |
Full path to the user's settings in xml format.
Determined by taking $main::SETTINGS->{dir}->{data} and adding
'mySettings.xml'. Default: /path/to/AmphetaDesk/data/mySettings.xml. |
| $main::SETTINGS->{files}->{services_channels} |
Full path to the master channel list.
Determined by taking $main::SETTINGS->{dir}->{lists} and adding
<file_services_channels>.
Default: /path/to/AmphetaDesk/data/internal/services-channels-recent.xml. |
| $main::SETTINGS->{files}->{version} |
Full path to the saved version file.
Determined by taking $main::SETTINGS->{dir}->{internal} and adding
<file_version>. Default:
/path/to/AmphetaDesk/data/internal/version.txt. |
| $main::SETTINGS->{tpl}->{add_a_channel} |
Full path to the "Add A Channel" page template, determined
by adding <tpl_add_a_channel>
to $main::SETTINGS->{dir}->{templates}. Default:
/path/to/AmphetaDesk/templates/add_a_channel.html. |
| $main::SETTINGS->{tpl}->{channel_footer} |
Full path to the channel footer template, determined
by adding <tpl_channel_footer>
to $main::SETTINGS->{dir}->{templates}. Default:
/path/to/AmphetaDesk/templates/channel_footer.html. |
| $main::SETTINGS->{tpl}->{channel_header} |
Full path to the channel title template, determined
by adding <tpl_channel_header>
to $main::SETTINGS->{dir}->{templates}. Default:
/path/to/AmphetaDesk/templates/channel_header.html. |
| $main::SETTINGS->{tpl}->{channel_item} |
Full path to the channel item template, determined
by adding <tpl_channel_item>
to $main::SETTINGS->{dir}->{templates}. Default:
/path/to/AmphetaDesk/templates/channel_item.html. |
| $main::SETTINGS->{tpl}->{channels_home} |
Full path to the "Channels Home" page template, also the
home page of AmphetaDesk. Determined by adding <tpl_channels_home>
to $main::SETTINGS->{dir}->{templates}. Default:
/path/to/AmphetaDesk/templates/index.html. |
| $main::SETTINGS->{tpl}->{channel_list_item} |
Full path to the list item template, determined
by adding <tpl_channel_list_item>
to $main::SETTINGS->{dir}->{templates}. Default:
/path/to/AmphetaDesk/templates/channel_list_item.html. |
| $main::SETTINGS->{tpl}->{channel_list_item_new} |
Full path to the "new" list item
template, determined by adding <tpl_channel_list_item_new>
to $main::SETTINGS->{dir}->{templates}. Default:
/path/to/AmphetaDesk/templates/channel_list_item_new.html. |
| $main::SETTINGS->{tpl}->{my_channels} |
Full path to the "My Channels" page template, determined
by adding <tpl_my_channels>
to $main::SETTINGS->{dir}->{templates}. Default:
/path/to/AmphetaDesk/templates/my_channels.html. |
| $main::SETTINGS->{tpl}->{my_settings} |
Full path to the "My Settings" page template, determined
by adding <tpl_my_settings>
to $main::SETTINGS->{dir}->{templates}. Default:
/path/to/AmphetaDesk/templates/my_settings.html. |
| $main::SETTINGS->{urls}->{add_a_channel} |
This is the full url to the
"Add a Channel" page. It's constructed by starting off
with "http://127.0.0.1:", adding <port>
and a "/" and finally adding <tpl_add_a_channel>.
Default: http://127.0.0.1:8888/add_a_channel.html
(although the port number is not set in stone). |
| $main::SETTINGS->{urls}->{channels_home} |
This is the full url to the
"Channels Home" page. It's constructed by starting off
with "http://127.0.0.1:", adding <port>
and a "/" and finally <tpl_channels_home>.
Default: http://127.0.0.1:8888/index.html
(although the port number is not set in stone). |
| $main::SETTINGS->{urls}->{my_channels} |
This is the full url to the
"My Channels" page. It's constructed by starting off
with "http://127.0.0.1:", adding <port>
and a "/" and then <tpl_my_channels>.
Default: http://127.0.0.1:8888/my_channels.html
(although the port number is not set in stone). |
| $main::SETTINGS->{urls}->{my_settings} |
This is the full url to the
"My Settings" page. It's constructed by starting off
with "http://127.0.0.1:", adding <port>
and a "/" and then <tpl_my_settings>.
Default: http://127.0.0.1:8888/my_settings.html
(although the port number is not set in stone). |
| $main::SETTINGS->{urls}->{port} |
This is the actual port that we've
been able to latch our webserver on to. This could be one of
three: <urls_port_default>,
<urls_port_secondary> or
<urls_port_tertiary>.
Default: most commonly, 8888. |
